<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TYCamport3: TYImageProc.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">TYCamport3
   &#160;<span id="projectnumber">3</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('a00008.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">TYImageProc.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="a00002_source.html">TYApi.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="a00005_source.html">TYCoordinateMapper.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="a00011_source.html">TyIsp.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for TYImageProc.h:</div>
<div class="dyncontent">
<div class="center"><img src="a00009.png" border="0" usemap="#_t_y_image_proc_8h" alt=""/></div>
<map name="_t_y_image_proc_8h" id="_t_y_image_proc_8h">
<area shape="rect" id="node2" href="a00002.html" title="TYApi.h includes camera control and data receiving interface, which supports configuration for image ..." alt="" coords="93,155,163,181"/>
<area shape="rect" id="node6" href="a00005.html" title="Coordinate Conversion API. " alt="" coords="163,80,330,107"/>
<area shape="rect" id="node7" href="a00011.html" title="TyIsp.h" alt="" coords="72,80,139,107"/>
</map>
</div>
</div>
<p><a href="a00008_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00181.html">DepthSpeckleFilterParameters</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">default parameter value definition  <a href="a00181.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00185.html">DepthEnhenceParameters</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">default parameter value definition  <a href="a00185.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ae8c400e207ceaa196d72c4473ea83563"><td class="memItemLeft" align="right" valign="top"><a id="ae8c400e207ceaa196d72c4473ea83563"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>DepthSpeckleFilterParameters_Initializer</b>&#160;&#160;&#160;{150, 64}</td></tr>
<tr class="separator:ae8c400e207ceaa196d72c4473ea83563"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76fde32b9f3093e7ba194683b7121bd6"><td class="memItemLeft" align="right" valign="top"><a id="a76fde32b9f3093e7ba194683b7121bd6"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>DepthEnhenceParameters_Initializer</b>&#160;&#160;&#160;{10, 20, 10, 0.1f}</td></tr>
<tr class="separator:a76fde32b9f3093e7ba194683b7121bd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a74321e8b166042ece04746cc88ab038e"><td class="memItemLeft" align="right" valign="top">TY_CAPI&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#a74321e8b166042ece04746cc88ab038e">TYImageProcesAcceEnable</a> (bool en)</td></tr>
<tr class="memdesc:a74321e8b166042ece04746cc88ab038e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Image processing acceleration switch.  <a href="#a74321e8b166042ece04746cc88ab038e">More...</a><br /></td></tr>
<tr class="separator:a74321e8b166042ece04746cc88ab038e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b464bbb119959e19acce5e0e96160f9"><td class="memItemLeft" align="right" valign="top">TY_CAPI&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#a1b464bbb119959e19acce5e0e96160f9">TYUndistortImage</a> (const <a class="el" href="a00077.html">TY_CAMERA_CALIB_INFO</a> *srcCalibInfo, const <a class="el" href="a00153.html">TY_IMAGE_DATA</a> *srcImage, const <a class="el" href="a00065.html">TY_CAMERA_INTRINSIC</a> *cameraNewIntrinsic, <a class="el" href="a00153.html">TY_IMAGE_DATA</a> *dstImage)</td></tr>
<tr class="memdesc:a1b464bbb119959e19acce5e0e96160f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Do image undistortion, only support TY_PIXEL_FORMAT_MONO ,TY_PIXEL_FORMAT_RGB,TY_PIXEL_FORMAT_BGR.  <a href="#a1b464bbb119959e19acce5e0e96160f9">More...</a><br /></td></tr>
<tr class="separator:a1b464bbb119959e19acce5e0e96160f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a797c07c57a28e7903725dd41963957d4"><td class="memItemLeft" align="right" valign="top">TY_CAPI&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#a797c07c57a28e7903725dd41963957d4">TYDepthSpeckleFilter</a> (<a class="el" href="a00153.html">TY_IMAGE_DATA</a> *depthImage, const <a class="el" href="a00181.html">DepthSpeckleFilterParameters</a> *param)</td></tr>
<tr class="memdesc:a797c07c57a28e7903725dd41963957d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove speckles on depth image.  <a href="#a797c07c57a28e7903725dd41963957d4">More...</a><br /></td></tr>
<tr class="separator:a797c07c57a28e7903725dd41963957d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8bb2a45b6fd8b542d250e2cd04e6d53"><td class="memItemLeft" align="right" valign="top">TY_CAPI&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html#af8bb2a45b6fd8b542d250e2cd04e6d53">TYDepthEnhenceFilter</a> (const <a class="el" href="a00153.html">TY_IMAGE_DATA</a> *depthImages, int imageNum, <a class="el" href="a00153.html">TY_IMAGE_DATA</a> *guide, <a class="el" href="a00153.html">TY_IMAGE_DATA</a> *output, const <a class="el" href="a00185.html">DepthEnhenceParameters</a> *param)</td></tr>
<tr class="memdesc:af8bb2a45b6fd8b542d250e2cd04e6d53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove speckles on depth image.  <a href="#af8bb2a45b6fd8b542d250e2cd04e6d53">More...</a><br /></td></tr>
<tr class="separator:af8bb2a45b6fd8b542d250e2cd04e6d53"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Image post-process API </p><dl class="section copyright"><dt>Copyright</dt><dd>Copyright(C)2016-2018 Percipio All Rights Reserved </dd></dl>

<p class="definition">Definition in file <a class="el" href="a00008_source.html">TYImageProc.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="af8bb2a45b6fd8b542d250e2cd04e6d53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8bb2a45b6fd8b542d250e2cd04e6d53">&#9670;&nbsp;</a></span>TYDepthEnhenceFilter()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TY_CAPI TYDepthEnhenceFilter </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00153.html">TY_IMAGE_DATA</a> *&#160;</td>
          <td class="paramname"><em>depthImages</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>imageNum</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00153.html">TY_IMAGE_DATA</a> *&#160;</td>
          <td class="paramname"><em>guide</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00153.html">TY_IMAGE_DATA</a> *&#160;</td>
          <td class="paramname"><em>output</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00185.html">DepthEnhenceParameters</a> *&#160;</td>
          <td class="paramname"><em>param</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Remove speckles on depth image. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">depthImage</td><td>Pointer to depth image array. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">imageNum</td><td>Depth image array size. </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">guide</td><td>Guide image. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Output depth image. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">param</td><td>Algorithm parameters. </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TY_STATUS_OK</td><td>Succeed. </td></tr>
    <tr><td class="paramname">TY_STATUS_NULL_POINTER</td><td>Any depthImage, param, output or output-&gt;buffer is NULL. </td></tr>
    <tr><td class="paramname">TY_STATUS_INVALID_PARAMETER</td><td>imageNum &gt;= 5 or imageNum &lt;= 0, or any image invalid </td></tr>
    <tr><td class="paramname">TY_STATUS_OUT_OF_MEMORY</td><td>Output image not suitable. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a797c07c57a28e7903725dd41963957d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a797c07c57a28e7903725dd41963957d4">&#9670;&nbsp;</a></span>TYDepthSpeckleFilter()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TY_CAPI TYDepthSpeckleFilter </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00153.html">TY_IMAGE_DATA</a> *&#160;</td>
          <td class="paramname"><em>depthImage</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00181.html">DepthSpeckleFilterParameters</a> *&#160;</td>
          <td class="paramname"><em>param</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Remove speckles on depth image. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">depthImage</td><td>Depth image to be processed. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">param</td><td>Algorithm parameters. </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TY_STATUS_OK</td><td>Succeed. </td></tr>
    <tr><td class="paramname">TY_STATUS_NULL_POINTER</td><td>Any depth, param or depth-&gt;buffer is NULL. </td></tr>
    <tr><td class="paramname">TY_STATUS_INVALID_PARAMETER</td><td>param-&gt;max_speckle_size &lt;= 0 or param-&gt;max_speckle_diff &lt;= 0 </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a74321e8b166042ece04746cc88ab038e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74321e8b166042ece04746cc88ab038e">&#9670;&nbsp;</a></span>TYImageProcesAcceEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TY_CAPI TYImageProcesAcceEnable </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>en</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Image processing acceleration switch. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">en</td><td>Enable image process acceleration switch </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a1b464bbb119959e19acce5e0e96160f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b464bbb119959e19acce5e0e96160f9">&#9670;&nbsp;</a></span>TYUndistortImage()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TY_CAPI TYUndistortImage </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00077.html">TY_CAMERA_CALIB_INFO</a> *&#160;</td>
          <td class="paramname"><em>srcCalibInfo</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00153.html">TY_IMAGE_DATA</a> *&#160;</td>
          <td class="paramname"><em>srcImage</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00065.html">TY_CAMERA_INTRINSIC</a> *&#160;</td>
          <td class="paramname"><em>cameraNewIntrinsic</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00153.html">TY_IMAGE_DATA</a> *&#160;</td>
          <td class="paramname"><em>dstImage</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Do image undistortion, only support TY_PIXEL_FORMAT_MONO ,TY_PIXEL_FORMAT_RGB,TY_PIXEL_FORMAT_BGR. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">srcCalibInfo</td><td>Image calibration data. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">srcImage</td><td>Source image. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">cameraNewIntrinsic</td><td>Expected new image intrinsic, will use srcCalibInfo for new image intrinsic if set to NULL. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">dstImage</td><td>Output image. </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TY_STATUS_OK</td><td>Succeed. </td></tr>
    <tr><td class="paramname">TY_STATUS_NULL_POINTER</td><td>Any srcCalibInfo, srcImage, dstImage, srcImage-&gt;buffer, dstImage-&gt;buffer is NULL. </td></tr>
    <tr><td class="paramname">TY_STATUS_INVALID_PARAMETER</td><td>Invalid srcImage-&gt;width, srcImage-&gt;height, dstImage-&gt;width, dstImage-&gt;height or unsupported pixel format. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="a00008.html">TYImageProc.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
